-
Notifications
You must be signed in to change notification settings - Fork 6
/
WeakEventListener`3.xml
169 lines (169 loc) · 9.56 KB
/
WeakEventListener`3.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<Type Name="WeakEventListener<TInstance,TSource,TEventArgs>" FullName="Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<TInstance,TSource,TEventArgs>">
<TypeSignature Language="C#" Value="public sealed class WeakEventListener<TInstance,TSource,TEventArgs> where TInstance : class" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit WeakEventListener`3<class TInstance, TSource, TEventArgs> extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class WeakEventListener(Of TInstance, TSource, TEventArgs)" />
<TypeSignature Language="F#" Value="type WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)> = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TInstance">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TSource" />
<TypeParameter Name="TEventArgs" />
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TInstance">Type of instance listening for the event.</typeparam>
<typeparam name="TSource">Type of source for the event.</typeparam>
<typeparam name="TEventArgs">Type of event arguments for the event.</typeparam>
<summary>
Implements a weak event listener that allows the owner to be garbage
collected if its only remaining link is an event handler.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WeakEventListener (TInstance instance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(!TInstance instance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3.#ctor(`0)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (instance As TInstance)" />
<MemberSignature Language="F#" Value="new Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)> : 'Instance -> Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)>" Usage="new Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)> instance" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="TInstance" />
</Parameters>
<Docs>
<param name="instance">Instance subscribing to the event.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Detach">
<MemberSignature Language="C#" Value="public void Detach ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Detach() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3.Detach" />
<MemberSignature Language="VB.NET" Value="Public Sub Detach ()" />
<MemberSignature Language="F#" Value="member this.Detach : unit -> unit" Usage="weakEventListener.Detach " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Detaches from the subscribed event.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnDetachAction">
<MemberSignature Language="C#" Value="public Action<Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<TInstance,TSource,TEventArgs>> OnDetachAction { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3<!TInstance, !TSource, !TEventArgs>> OnDetachAction" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3.OnDetachAction" />
<MemberSignature Language="VB.NET" Value="Public Property OnDetachAction As Action(Of WeakEventListener(Of TInstance, TSource, TEventArgs))" />
<MemberSignature Language="F#" Value="member this.OnDetachAction : Action<Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs>> with get, set" Usage="Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)>.OnDetachAction" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<TInstance,TSource,TEventArgs>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the method to call when detaching from the event.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEvent">
<MemberSignature Language="C#" Value="public void OnEvent (TSource source, TEventArgs eventArgs);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnEvent(!TSource source, !TEventArgs eventArgs) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3.OnEvent(`1,`2)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnEvent (source As TSource, eventArgs As TEventArgs)" />
<MemberSignature Language="F#" Value="member this.OnEvent : 'Source * 'EventArgs -> unit" Usage="weakEventListener.OnEvent (source, eventArgs)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="TSource" />
<Parameter Name="eventArgs" Type="TEventArgs" />
</Parameters>
<Docs>
<param name="source">Event source.</param>
<param name="eventArgs">Event arguments.</param>
<summary>
Handler for the subscribed event calls OnEventAction to handle it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEventAction">
<MemberSignature Language="C#" Value="public Action<TInstance,TSource,TEventArgs> OnEventAction { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`3<!TInstance, !TSource, !TEventArgs> OnEventAction" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.Helpers.WeakEventListener`3.OnEventAction" />
<MemberSignature Language="VB.NET" Value="Public Property OnEventAction As Action(Of TInstance, TSource, TEventArgs)" />
<MemberSignature Language="F#" Value="member this.OnEventAction : Action<'Instance, 'Source, 'EventArgs (requires 'Instance : null)> with get, set" Usage="Microsoft.Toolkit.Uwp.Helpers.WeakEventListener<'Instance, 'Source, 'EventArgs (requires 'Instance : null)>.OnEventAction" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<TInstance,TSource,TEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the method to call when the event fires.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>